Skip to content

DOC: Add gallery example to show text formatting #3987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Jul 20, 2025
Merged

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jun 21, 2025

Description of proposed changes

Gallery example related to #3976 for formatting text.

Fixes #3976 (comment)

Preview: https://pygmt-dev--3987.org.readthedocs.build/en/3987/gallery/embellishments/text_formatting.html

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added this to the 0.17.0 milestone Jun 21, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Jun 21, 2025
@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Jun 21, 2025
@yvonnefroehlich yvonnefroehlich marked this pull request as draft June 21, 2025 16:23
@seisman
Copy link
Member

seisman commented Jun 24, 2025

Maybe also use formatted text for the plot label and title?

@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review July 18, 2025 10:26
@seisman seisman added the needs review This PR has higher priority and needs review. label Jul 19, 2025
yvonnefroehlich and others added 3 commits July 19, 2025 14:28
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Jul 19, 2025
@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Jul 19, 2025

There seem to be currently some issues with accessing the GMT server (oceania), leading to failing Docs build. I can reproduce this issue locally, e.g.,
legend tutorial

GMTCLibError: Module 'legend' failed with status code 16:
legend [ERROR]: Libcurl Error: Timeout was reached
legend [ERROR]: Unable to obtain remote file @SOEST_block4.png
legend [ERROR]: Cannot find/open file @SOEST_block4.png.
legend [ERROR]: Libcurl Error: Timeout was reached
legend [ERROR]: Unable to obtain remote file @SOEST_block4.png
legend [ERROR]: Cannot find/open file @SOEST_block4.png.

image example

GMTCLibError: Module 'image' failed with status code 72:
image [ERROR]: Libcurl Error: Timeout was reached
image [ERROR]: Unable to obtain remote file https://oceania.generic-mapping-tools.org/cache/needle.jpg

I also have problems to access the GMT forum. Update / Edit: Accessing the forum works for me again.

@seisman seisman merged commit 12b789b into main Jul 20, 2025
8 of 11 checks passed
@seisman seisman deleted the add-gallery-textformat branch July 20, 2025 09:29
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jul 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants